home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / ASHOWDEM.ZIP / AVSHOW2.DOC < prev    next >
Encoding:
Text File  |  1995-12-18  |  14.3 KB  |  359 lines
  1.                          ANSI/ASCII SLIDESHOW
  2.                         Copyright December, 1995
  3.                  Alpine Village Software by John Rice
  4.  
  5. ASHOW is a 'presentation' program, designed to sequentially present
  6. ASCII or ANSI files 'screens', to the user. Originally designed for
  7. use as an 'Advertiser' at ONEBBScon, this program can also be used
  8. for applications such as; Giving a new user a 'guided tour' through
  9. your system, or creating a training presentation.
  10.  
  11. ASHOW2 is Version 2 of ASHOW. In version 2 capability is added to
  12. automatically present ANSI screens to users when entering selected
  13. menus. This is primarily designed to do 'advertising', however other
  14. uses are possible.
  15.  
  16. Files:
  17.         AVSHOW2 is distributed with the following files:
  18.        
  19.         AVSHOW2.TPG     The Program file
  20.         AVSHOW2.DOC     This File
  21.         AVINIT.TPG      The Line initialization file.
  22.         AVRUN.TPG       The Menu File 'runner'.
  23.         ASHOW.ANS       The ASHOW Main Menu screen
  24.        
  25.         The following files will be created when ASHOW first runs.
  26.  
  27.         A2FILES.DBF     The file list datafile
  28.         A2FILES.NDX     The file list index
  29.         ASHCFG.DBF      This file holds default drive and path info.
  30.         A2LINES.DBF     The 'lines' configuration file.
  31.         A2LINES.NDX     The 'lines' file index.
  32.                
  33.         ASHKEY.DBF      The license keyfile. (Not present in demo
  34.                         versions).
  35.  
  36. Configurability:
  37.  
  38. Active -    A line can be configured to be 'Active' or not Active.
  39.             A line that is configured to be not active, will be
  40.             skipped. i.e. users on that line will not be shown
  41.             ansi files, no matter how often they enter enabled menus.
  42.  
  43. Frequency - A 'counter' is stored in the 'lines database' for each
  44.             line. Every time the user on that line enters a AVRUN
  45.             equipped menu, the counter is incremented. Each line has a
  46.             'frequency' setting which will determine how often screens
  47.             will be displayed. When the 'counter' matches the
  48.             'frequency', a file is displayed and the counter is reset.
  49.             So if the 'frequency' is 3, then every third time a user
  50.             enters a AVRUN equipped menu, the next file will be
  51.             presented.
  52.            
  53. Starting -  Each line can be configured to start at the 'Beginning' of
  54.             the file list, or at a random point in the list. For large
  55.             lists, it may be better to start at a random point to
  56.             ensure a better distribution of files presented.
  57.  
  58. Prompting - During display of files the user can be 'automatically'
  59.             prompted for file download, or the SYSOP can manually
  60.             add prompting to displayed screens.
  61.  
  62.  
  63. TPG Files:
  64.  
  65. AVSHOW2 -
  66.  
  67.     AVSHOW2 is the main program file. This file can be placed in a
  68.     menu for 'users' and when selected by a user will operate in
  69.     'slideshow' mode. Slideshow Mode presents a series of ANSI screens
  70.     to the user, in order of their entry in the File List.
  71.    
  72.     When AVSHOW2 is selected by the SYSOP, a menu appears which
  73.     includes configuration elements. Configuration includes, addition
  74.     and maintenance of files, in the File List and configuration of
  75.     'Lines' in the Lines database.
  76.    
  77. AVINIT -
  78.  
  79.     AVINIT is placed as an 'autoexecute' in menu 0000. When a new user
  80.     logs in, AVINIT will initialize their 'line' to a starting point
  81.     in the files list (the beginning or a randomly selected file) and
  82.     initialize the 'frequency' of appearance of ANSI files when they
  83.     enter a menu which includes  AVRUN.
  84.    
  85. AVRUN -
  86.  
  87.     AVRUN is placed as an 'autoexecute' in selected menus where you
  88.     wish to automatically present ANSI files, to your users. Each time
  89.     a user enters one of these menus, AVRUN will check to see if the
  90.     line is 'active' (configured to allow the 'show'), and determine
  91.     if the 'frequency' has occurred to trigger a file to be displayed.
  92.    
  93.  
  94.        
  95. INSTALLATION:
  96.  
  97. Create a separate directory ASHOW2 and copy the supplied files there.
  98.  
  99. Menu Entries:
  100.  
  101. The Main Program (and configuration program) (AVSHOW2.TPG) :
  102.  
  103. Create a menu item in any menu as follows:
  104.  
  105. Entry:
  106.  
  107. Key=X Type=200 Opt Data=\path\to\avshow2\avshow2 /Q
  108.  
  109. or:
  110.  
  111. Key=X Type=200 Opt Data=\path\to\avshow2\avshow2 /Q && /P
  112.  
  113. At the 'main menu':
  114.  
  115. The USER will see Menu Items for <R>un and <Q>uit.
  116.  
  117. The SYSOP will see Extra Menu items to:
  118.  
  119.     <C>onfigure defaults
  120.     <L> Configure Lines
  121.     <S>how files in the list
  122.     <A>dd Files to File list
  123.     <P>rint the File List
  124.     <E>dit Entries on the File list
  125.     <Z>ap The File list and start over
  126.  
  127. While the show is running:
  128.  
  129.     If "&& /P" is added to the TYPE=200 command line, the user will be
  130.     automatically prompted to <D>ownload attached files, if an Attached
  131.     file exists. Also the user will get prompted for <P>ause, <Q>uit.
  132.  
  133.  
  134. The Lines Initialization file (AVINIT.TPG) :
  135.  
  136. Create an entry in menu0000 to initialize a users line when they log
  137. in that looks like:
  138.  
  139. Entry:
  140. Key=^@ Type=200 Opt Data=\path\to\avshow2\avinit /Q
  141.  
  142. Where the '\path\to\avshow2' is the subdirectory where you installed
  143. AVSHOW2 files.
  144.  
  145.  
  146. The Runtime file (AVRUN.TPG):
  147.  
  148. Create an entry at the top of each of your menus where you want to
  149. automatically present files that looks like:
  150.  
  151. Entry:
  152.  
  153. Key=^@ Type=200 Opt Data=\path\to\avshow2\avrun /Q
  154.  
  155. or
  156.  
  157. Key=^@ Type=200 Opt Data=\path\to\avshow2\avrun /Q && /P
  158.  
  159. Where the '\path\to\avshow2' is the subdirectory where you installed
  160. AVSHOW2 files.
  161.  
  162. While a file is displayed:
  163.  
  164.     If "&& /P" is added to the TYPE=200 command line, the user will be
  165.     automatically prompted to <D>ownload attached files, if an Attached
  166.     file exists. Also the user will get prompted for <P>ause, <Q>uit.
  167.  
  168. ******
  169.  
  170. SCREENS:
  171.  
  172. <C>onfiguration Screen allows you to pre-set 'Drive', 'Path' and
  173.    'Delay' entries, which will be defaults when you add files to the
  174.     database. These defaults can be overridden for each entry in the
  175.     database, but it makes building a long list of files go much faster,
  176.     if they're all in the same sub-directory.
  177.  
  178. <A>dd, Adds files to the list. Files can be added at any time, and
  179.    'inserted' into the display order, just by virtue of their assigned
  180.    'sequence' number. Files can be quickly added by entering a
  181.    starting 'sequence' number and sequencing 'increment'.
  182.   
  183. <S>how lists all files and their sequence numbers. It's possible for
  184.    two files to have the same sequence number. If this happens, just
  185.    use <E>dit to change one of them to another number.
  186.  
  187.    <E>dit will allow you to make corrections, or replace an entry in
  188.       the file list. It also allows you to define display 'sequence'
  189.       numbers which determine the order in which files are displayed.
  190.       Files can be moved, in the display order, simply by changing the
  191.       sequence number. If you accidentally get two files with the same
  192.       sequence number, this won't hurt anything, but either file may
  193.       display 'first', or one of the files may not show at all. It's
  194.       best to use the editor to change the sequence number of one of
  195.       the files.
  196.  
  197. <Z>ap the list and start over. When the file list is deleted, the
  198.    original list and it's associated index file are saved. To recover
  199.    the list, use DOS to rename the files ashdbf.sav to afiles.dbf, and
  200.    ashndx.sav to afiles.ndx.
  201.  
  202. When Adding or Editing the file list, the program verifies that the
  203. entered file exists, but will allow you to override the check, if
  204. you're going to add the file later. 'Attached' files are NOT verified.
  205.  
  206.  
  207. CONFIGURATION:
  208.  
  209. Configuring the Files database:
  210.  
  211. The files database is created and initialized, the first time <C>onfigure
  212. defaults is selected from the SysOp Menu. The database is initialized
  213. with one file in 'Sequence 0', using the AVSHOW.ANS menu screen, as an
  214. example. This entry can then be changed by the SysOp to any file.
  215.  
  216. In the <A>dd Files and <E>dit files screens:
  217.  
  218.         Seq: This is the 'index' sequence in which files will be presented.
  219.       Drive: This is the Drive on which these files reside.
  220.        Path: This is the directory 'path' to the file.
  221.        File: This is the individual File Name
  222. Description: An optional description of what this file is.
  223.      Attach: An 'attached' file which may be downloaded from this screen
  224.              when it's shown to the user.
  225.  
  226.     Note: Attached files must include the fully qualified path to the
  227.           file. ie: c:\attchd\filename.sfx
  228.  
  229.     SYSOP FEATURE: While a file is being displayed (In either AVSHOW2
  230.     or AVRUN) entering ^I (Control + I) will cause the 'Sequence
  231.     Number" to be displayed on the lower right hand corner of the
  232.     screen. This is provided to help identify screens during
  233.     configuration and troubleshooting.
  234.  
  235. Configuring Lines:
  236.  
  237. The lines database is initially built by the program, the first time
  238. 'Configure <L>ines is selected from the SysOp Menu,  with all lines
  239. configured as 'Active', with a 'Frequency' of 3 and starting at the
  240. 'Beginning' of the file list.
  241.  
  242. If you have users logging in on lines where you DO NOT want them to
  243. see 'advertising', configure these lines as 'Active = N'. (SysOps
  244. and co-SysOps, for example).
  245.  
  246. Determine how often you wish to display files. (See the definition of
  247. 'frequency' above. Different lines can have different 'frequencies',
  248. for example if you have a group of 'public lines' and separate group
  249. of 'private lines (for subscribers) you might want to have advertising
  250. presented to the 'public' more often than to the 'subscribers', so you
  251. would set the 'frequency' number lower on the 'public' lines.
  252.  
  253. Determine where you want lines to start in the file list. If you only
  254. have a few files (10-20) you may want to always start at the beginning
  255. of the list. If you have many files, you might want to start at a
  256. random point in the list to make sure that users aren't seeing the
  257. same files every time they log in.
  258.  
  259. Lines can be configured individually, or 'globally' ie: Global change
  260. will apply to ALL lines
  261.  
  262.  
  263. Usage Notes:
  264.             The file ashow.ans is the 'backdrop' screen for the menus.
  265.             It is possible to completely replace the main menu screen,
  266.             except for the menu select line, by replacing ashow.ans with
  267.             your own Menu Screen. To do this, create an ANSI or ASCII
  268.             screen and name it ashow.ans .
  269.  
  270.             AVSHOW2 displays files in order of the 'Sequence number'
  271.             assigned to the file entry in the list. Sequence numbers
  272.             do not need to be added in order, thus you can start your
  273.             list with numbers of 10, 20, 30, etc and if you want to
  274.             insert a file in the middle of the list, just add the file
  275.             with a sequence number that will cause it to display where
  276.             you want it in the list (like 25 will display between 20
  277.             and 30).
  278.            
  279.             To temporarily delete an entry, erase the file name and
  280.             the entry will be skipped. You can go back later and use
  281.             the 'slot' for another file, and change the sequence
  282.             number to place it where you want it.
  283.  
  284.             While AVSHOW2 can use files located anywhere on the system, I
  285.             find it's easier to keep track of and maintain if you define
  286.             a separate sub-directory to hold most of your ASHOW files.
  287.             I use /ashow2/files.
  288.  
  289.             DEMO Mode - An 'unlicensed' ASHOW runs in Demo Mode. In
  290.             this mode, there is a limit of 5 files in the 'show'. Also
  291.             each displayed file with have a 'demo message' placed over
  292.             the displayed file. The licensed version removes the demo
  293.             message and 5 file limit.
  294.  
  295.  
  296.             AVRUN can be installed in as many (or as few) menus as you
  297.             wish. Be careful not to overwhelm your users with
  298.             advertising, if you hit them too often, you'll hear about
  299.             it. You can either run 'ads' in fewer menus, or decrease
  300.             the frequency (increase the 'frequency' entry in the lines
  301.             configuration) until you find a reasonable balance.
  302.  
  303.             Additional 'filtering' can be done using PRIV levels and
  304.             'A' flags, to limit displays to 'groups' of users.
  305.  
  306.  
  307.             There are some ANSI files that will not display with
  308.             AVSHOW. Some methods of 'saving' files from THEDRAW and
  309.             other drawing programs produce ANSI files that override
  310.             EOL processing by TDBS. I've found that many of these
  311.             files can be made AVSHOW compatible by using 'BLOCK SAVE'
  312.             in THEDRAW or loading the files into ANSI PAINT and
  313.             re-saving them.
  314.           
  315. History:
  316.  
  317.         July 17, 1994 - Initial release.
  318.  
  319.         July 24, 1994 -  V 1.2 List Edit enhanced
  320.                               Show file list added
  321.  
  322.         July 25, 1994 -  V 1.24 List Edit enhanced again
  323.                                Add files routine enhanced.
  324.  
  325.         August 1, 1994 -  V 1.25 Official Release
  326.                                 Added <P>ause during run.
  327.                                 Revised <Z>ap, to save index file.
  328.                                 Added Demo Mode and Keyfile
  329.  
  330.         August 1, 1994 -  V 1.3  Added 'Description' field to database.
  331.  
  332.         August 11, 1994 - V 1.31 Added <-> during 'show' to back-up
  333.                                  one screen.
  334.        
  335.         December 2, 1995 - V 2.0  Released Version 2 - See docs.
  336.        
  337.         December 12, 1995 - V2.02 Revised File List <E>dit function.
  338.  
  339.         December 16, 1995 - V2.03 Added ^I for SYSOP to display
  340.                             'Sequence Number' during 'show' display.
  341.                            
  342.                             Added '&& /P' command line switch option.
  343.  
  344. Warranty :
  345.        
  346.     Use ASHOW at your own risk. ASHOW has been extensively tested and should
  347. not inherently cause problems in any system. I express no warranty and take
  348. no responsibility for damages that may occur to files used (or not used) by
  349. AVshow2 or its associated files.
  350.  
  351.     Please report any problems with ASHOW to me directly or to the
  352. distributor from who you purchased this program.
  353.  
  354. John Rice
  355. Alpine Village Software
  356. P.O. Box 935
  357. Lake Zurich, Ill 60047
  358. rice@avsoft.com
  359.